import request from "@/utils/request";

const PROGRAMS_BASE_URL = "/api/v1/programs";

const ProgramsAPI = {
    /** 获取教材信息分页数据 */
    getPage(queryParams?: ProgramsPageQuery) {
        return request<any, PageResult<ProgramsPageVO[]>>({
            url: `${PROGRAMS_BASE_URL}/page`,
            method: "get",
            params: queryParams,
        });
    },
    /**
     * 获取教材信息表单数据
     *
     * @param id 教材信息ID
     * @returns 教材信息表单数据
     */
    getFormData(id: number) {
        return request<any, ProgramsForm>({
            url: `${PROGRAMS_BASE_URL}/${id}/form`,
            method: "get",
        });
    },

    /**
     *  添加教材信息
     *
     *  @param data 教材信息表单数据
     */
    add(data: ProgramsForm) {
        return request({
            url: `${PROGRAMS_BASE_URL}`,
            method: "post",
            data: data,
        });
    },

    /**
     * 更新教材信息
     *
     * @param id 教材信息ID
     * @param data 教材信息表单数据
     */
     update(id: number, data: ProgramsForm) {
        return request({
            url: `${PROGRAMS_BASE_URL}/${id}`,
            method: "put",
            data: data,
        });
    },

    /**
     * 批量删除教材信息，多个以英文逗号(,)分割
     *
     * @param ids 教材信息ID字符串，多个以英文逗号(,)分割
     */
     deleteByIds(ids: string) {
        return request({
            url: `${PROGRAMS_BASE_URL}/${ids}`,
            method: "delete",
        });
    }
}

export default ProgramsAPI;

/** 教材信息分页查询参数 */
export interface ProgramsPageQuery extends PageQuery {
    /** 所属系列ID */
    seriesId?: number;
    /** 教材名称 */
    name?: string;
    /** 总单词数 */
    totalWords?: number;
    /** 教材简体中文名 */
    nameZhCn?: string;
}

/** 教材信息表单对象 */
export interface ProgramsForm {
    /** 教材ID */
    id?:  number;
    /** 所属系列ID */
    seriesId?:  number;
    /** 教材名称 */
    name?:  string;
    /** 总单词数 */
    totalWords?:  number;
    /** 语言,如Simplified-Chinese */
    expLanguage?:  string;
    /** 教材英文名 */
    nameEnUs?:  string;
    /** 教材简体中文名 */
    nameZhCn?:  string;
    /** 教材繁体中文名 */
    nameZhBig?:  string;
    /** 显示顺序 */
    dispOrder?:  number;
    /** 备注 */
    remark?:  string;
    /** 类别 */
    type?:  number;
    /** 创建人 */
    createUser?:  number;
    /** 更新人 */
    updateUser?:  number;
    /** 状态 */
    status?:  number;
    /** 学习人数 */
    studyNumber?:  number;
    /** 完成百分比 */
    percent?:  number;
}

/** 教材信息分页对象 */
export interface ProgramsPageVO {
    /** 教材ID */
    id?: number;
    /** 所属系列ID */
    seriesId?: number;
    /** 教材名称 */
    name?: string;
    /** 总单词数 */
    totalWords?: number;
    /** 语言,如Simplified-Chinese */
    expLanguage?: string;
    /** 教材英文名 */
    nameEnUs?: string;
    /** 教材简体中文名 */
    nameZhCn?: string;
    /** 教材繁体中文名 */
    nameZhBig?: string;
    /** 显示顺序 */
    dispOrder?: number;
    /** 备注 */
    remark?: string;
    /** 类别 */
    type?: number;
    /** 创建人 */
    createUser?: number;
    /** 更新人 */
    updateUser?: number;
    /** 状态 */
    status?: number;
    /** 学习人数 */
    studyNumber?: number;
    /** 完成百分比 */
    percent?: number;
}
